home *** CD-ROM | disk | FTP | other *** search
XXXXmmmmFFFFrrrraaaammmmeeee((((3333XXXX)))) UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV XXXXmmmmFFFFrrrraaaammmmeeee((((3333XXXX)))) NNNNAAAAMMMMEEEE XXXXmmmmFFFFrrrraaaammmmeeee - The Frame widget class SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS #include <Xm/Frame.h> VVVVEEEERRRRSSSSIIIIOOOONNNN This page documents Motif 2.1. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN Frame is a very simple manager used to enclose a single work area child in a border drawn by Frame. It uses the Manager class resources for border drawing and performs geometry management so that its size always matches its child's outer size plus the Frame's margins and shadow thickness. Frame is most often used to enclose other managers when the application developer wants the manager to have the same border appearance as the primitive widgets. Frame can also be used to enclose primitive widgets that do not support the same type of border drawing. This gives visual consistency when you develop applications using diverse widget sets. Constraint resources are used to designate a child as the Frame title, align its text, and control its vertical alignment in relation to Frame's top shadow. The title appears only at the top of the Frame. If the Frame's parent is a Shell widget, the XXXXmmmmNNNNsssshhhhaaaaddddoooowwwwTTTTyyyyppppeeee resource defaults to XXXXmmmmSSSSHHHHAAAADDDDOOOOWWWW____OOOOUUUUTTTT, and the Manager's XXXXmmmmNNNNsssshhhhaaaaddddoooowwwwTTTThhhhiiiicccckkkknnnneeeessssssss resource defaults to 1. If the Frame's parent is not a Shell widget, the XXXXmmmmNNNNsssshhhhaaaaddddoooowwwwTTTTyyyyppppeeee resouce defaults to XXXXmmmmSSSSHHHHAAAADDDDOOOOWWWW____EEEETTTTCCCCHHHHEEEEDDDD____IIIINNNN, and the Manager's XXXXmmmmNNNNsssshhhhaaaaddddoooowwwwTTTThhhhiiiicccckkkknnnneeeessssssss resource defaults to 2. CCCCllllaaaasssssssseeeessss Frame inherits behavior and resources from the CCCCoooorrrreeee, CCCCoooommmmppppoooossssiiiitttteeee, CCCCoooonnnnssssttttrrrraaaaiiiinnnntttt, and XXXXmmmmMMMMaaaannnnaaaaggggeeeerrrr classes. The class pointer is _x_m_F_r_a_m_e_W_i_d_g_e_t_C_l_a_s_s. The class name is XXXXmmmmFFFFrrrraaaammmmeeee. NNNNeeeewwww RRRReeeessssoooouuuurrrrcccceeeessss The following table defines a set of widget resources used by the programmer to specify data. The programmer can also set the resource values for the inherited classes to set attributes for this widget. To reference a resource by name or by class in a ....XXXXddddeeeeffffaaaauuuullllttttssss file, remove the XXXXmmmmNNNN or XXXXmmmmCCCC prefix and use the remaining letters. To specify one of the defined values for a resource in a ....XXXXddddeeeeffffaaaauuuullllttttssss file, remove the XXXXmmmm prefix and use the remaining letters (in either Page 1 (printed 10/3/02) XXXXmmmmFFFFrrrraaaammmmeeee((((3333XXXX)))) UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV XXXXmmmmFFFFrrrraaaammmmeeee((((3333XXXX)))) lowercase or uppercase, but include any underscores between words). The codes in the access column indicate if the given resource can be set at creation time (C), set by using XXXXttttSSSSeeeettttVVVVaaaalllluuuueeeessss (S), retrieved by using XXXXttttGGGGeeeettttVVVVaaaalllluuuueeeessss (G), or is not applicable (N/A). XXXXmmmmFFFFrrrraaaammmmeeee RRRReeeessssoooouuuurrrrcccceeee SSSSeeeetttt NNNNaaaammmmeeee CCCCllllaaaassssssss TTTTyyyyppppeeee DDDDeeeeffffaaaauuuulllltttt AAAAcccccccceeeessssssss XmNmarginWidth XmCMarginWidth Dimension 0 CSG XmNmarginHeight XmCMarginHeight Dimension 0 CSG XmNshadowType XmCShadowType unsigned char dynamic CSG XXXXmmmmNNNNmmmmaaaarrrrggggiiiinnnnWWWWiiiiddddtttthhhh Specifies the padding space on the left and right sides between Frame's child and Frame's shadow drawing. XXXXmmmmNNNNmmmmaaaarrrrggggiiiinnnnHHHHeeeeiiiigggghhhhtttt Specifies the padding space on the top and bottom sides between Frame's child and Frame's shadow drawing. When a title is present, the top margin equals the value specified by this resource plus the distance (if any) that the title extends below the top shadow. XXXXmmmmNNNNsssshhhhaaaaddddoooowwwwTTTTyyyyppppeeee Describes the drawing style for Frame. This resource can have the following values: XXXXmmmmSSSSHHHHAAAADDDDOOOOWWWW____IIIINNNN Draws Frame so that it appears inset. This means that the bottom shadow visuals and top shadow visuals are reversed. XXXXmmmmSSSSHHHHAAAADDDDOOOOWWWW____OOOOUUUUTTTT Draws Frame so that it appears outset. This is the default if Frame's parent is a Shell widget. XXXXmmmmSSSSHHHHAAAADDDDOOOOWWWW____EEEETTTTCCCCHHHHEEEEDDDD____IIIINNNN Draws Frame using a double line giving the effect of a line etched into the window. The thickness of the double line is equal to the value of XXXXmmmmNNNNsssshhhhaaaaddddoooowwwwTTTThhhhiiiicccckkkknnnneeeessssssss. This is the default when Frame's parent is not a Shell widget. XXXXmmmmSSSSHHHHAAAADDDDOOOOWWWW____EEEETTTTCCCCHHHHEEEEDDDD____OOOOUUUUTTTT Draws Frame using a double line giving the effect of a line coming out of the Page 2 (printed 10/3/02) XXXXmmmmFFFFrrrraaaammmmeeee((((3333XXXX)))) UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV XXXXmmmmFFFFrrrraaaammmmeeee((((3333XXXX)))) window. The thickness of the double line is equal to the value of XXXXmmmmNNNNsssshhhhaaaaddddoooowwwwTTTThhhhiiiicccckkkknnnneeeessssssss. XXXXmmmmFFFFrrrraaaammmmeeee CCCCoooonnnnssssttttrrrraaaaiiiinnnntttt RRRReeeessssoooouuuurrrrcccceeee SSSSeeeetttt NNNNaaaammmmeeee CCCCllllaaaassssssss TTTTyyyyppppeeee DDDDeeeeffffaaaauuuulllltttt AAAAcccccccceeeessssssss XmNchildType XmCChildType unsigned char XmFRAME_WORKAREA_CHILD CSG XmNchildHorizontalAlignment XmCChildHorizontalAlignment unsigned char XmALIGNMENT_BEGINNING CSG XmNchildHorizontalSpacing XmCChildHorizontalSpacing Dimension dynamic CSG XmNchildVerticalAlignment XmCChildVerticalAlignment unsigned char XmALIGNMENT_CENTER CSG XmNframeChildType XmCFrameChildType unsigned char XmFRAME_WORKAREA_CHILD CSG XXXXmmmmNNNNcccchhhhiiiillllddddTTTTyyyyppppeeee Refer to the XXXXmmmmNNNNffffrrrraaaammmmeeeeCCCChhhhiiiillllddddTTTTyyyyppppeeee resource description. The XXXXmmmmNNNNcccchhhhiiiillllddddTTTTyyyyppppeeee resource is obsoleted by XXXXmmmmNNNNffffrrrraaaammmmeeeeCCCChhhhiiiillllddddTTTTyyyyppppeeee, but is kept here for backward compatibility. XXXXmmmmNNNNcccchhhhiiiillllddddHHHHoooorrrriiiizzzzoooonnnnttttaaaallllAAAAlllliiiiggggnnnnmmmmeeeennnntttt Specifies the alignment of the title. This resource has the following values: +o XXXXmmmmAAAALLLLIIIIGGGGNNNNMMMMEEEENNNNTTTT____BBBBEEEEGGGGIIIINNNNNNNNIIIINNNNGGGG +o XXXXmmmmAAAALLLLIIIIGGGGNNNNMMMMEEEENNNNTTTT____CCCCEEEENNNNTTTTEEEERRRR +o XXXXmmmmAAAALLLLIIIIGGGGNNNNMMMMEEEENNNNTTTT____EEEENNNNDDDD See the description of XXXXmmmmNNNNaaaalllliiiiggggnnnnmmmmeeeennnntttt in the XXXXmmmmLLLLaaaabbbbeeeellllreference page for an explanation of these values. XXXXmmmmNNNNcccchhhhiiiillllddddHHHHoooorrrriiiizzzzoooonnnnttttaaaallllSSSSppppaaaacccciiiinnnngggg Specifies the minimum distance between either edge of the title text and the inner edge of the Frame shadow. Clipping of the title text occurs in order to maintain this spacing. The default value is the margin width of the Frame. XXXXmmmmNNNNcccchhhhiiiillllddddVVVVeeeerrrrttttiiiiccccaaaallllAAAAlllliiiiggggnnnnmmmmeeeennnntttt Specifies the vertical alignment of the title text, or the title area in relation to the top shadow of the Frame. XXXXmmmmAAAALLLLIIIIGGGGNNNNMMMMEEEENNNNTTTT____BBBBAAAASSSSEEEELLLLIIIINNNNEEEE____BBBBOOOOTTTTTTTTOOOOMMMM Causes the baseline of the title to align vertically with the top shadow of the Frame. In the case of a multi-line title, the baseline of the last line of text aligns vertically with the top shadow of the Frame. Page 3 (printed 10/3/02) XXXXmmmmFFFFrrrraaaammmmeeee((((3333XXXX)))) UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV XXXXmmmmFFFFrrrraaaammmmeeee((((3333XXXX)))) XXXXmmmmAAAALLLLIIIIGGGGNNNNMMMMEEEENNNNTTTT____BBBBAAAASSSSEEEELLLLIIIINNNNEEEE____TTTTOOOOPPPP Causes the baseline of the first line of the title to align vertically with the top shadow of the Frame. XXXXmmmmAAAALLLLIIIIGGGGNNNNMMMMEEEENNNNTTTT____CCCCHHHHIIIILLLLDDDD____TTTTOOOOPPPP Causes the top edge of the title area to align vertically with the top shadow of the Frame. XXXXmmmmAAAALLLLIIIIGGGGNNNNMMMMEEEENNNNTTTT____CCCCEEEENNNNTTTTEEEERRRR Causes the center of the title area to align vertically with the top shadow of the Frame. XXXXmmmmAAAALLLLIIIIGGGGNNNNMMMMEEEENNNNTTTT____CCCCHHHHIIIILLLLDDDD____BBBBOOOOTTTTTTTTOOOOMMMM Causes the bottom edge of the title area to align vertically with the top shadow of the Frame. XXXXmmmmNNNNffffrrrraaaammmmeeeeCCCChhhhiiiillllddddTTTTyyyyppppeeee Specifies whether a child is a title or work area. Frame supports a single title and/or work area child. The possible values are +o XXXXmmmmFFFFRRRRAAAAMMMMEEEE____TTTTIIIITTTTLLLLEEEE____CCCCHHHHIIIILLLLDDDD +o XXXXmmmmFFFFRRRRAAAAMMMMEEEE____WWWWOOOORRRRKKKKAAAARRRREEEEAAAA____CCCCHHHHIIIILLLLDDDD +o XXXXmmmmFFFFRRRRAAAAMMMMEEEE____GGGGEEEENNNNEEEERRRRIIIICCCC____CCCCHHHHIIIILLLLDDDD The Frame geometry manager ignores any child of type XXXXmmmmFFFFRRRRAAAAMMMMEEEE____GGGGEEEENNNNEEEERRRRIIIICCCC____CCCCHHHHIIIILLLLDDDD. This resource replaces XXXXmmmmNNNNcccchhhhiiiillllddddTTTTyyyyppppeeee. IIIInnnnhhhheeeerrrriiiitttteeeedddd RRRReeeessssoooouuuurrrrcccceeeessss Frame inherits behavior and resources from the following superclasses. For a complete description of each resource, refer to the reference page for that superclass. XXXXmmmmMMMMaaaannnnaaaaggggeeeerrrr RRRReeeessssoooouuuurrrrcccceeee SSSSeeeetttt NNNNaaaammmmeeee CCCCllllaaaassssssss TTTTyyyyppppeeee DDDDeeeeffffaaaauuuulllltttt AAAAcccccccceeeessssssss XmNbottomShadowColor XmCBottomShadowColor Pixel dynamic CSG XmNbottomShadowPixmap XmCBottomShadowPixmap Pixmap XmUNSPECIFIED_PIXMAP CSG XmNforeground XmCForeground Pixel dynamic CSG XmNhelpCallback XmCCallback XtCallbackList NULL C XmNhighlightColor XmCHighlightColor Pixel dynamic CSG XmNhighlightPixmap XmCHighlightPixmap Pixmap dynamic CSG XmNinitialFocus XmCInitialFocus Widget NULL CSG XmNlayoutDirection XmCLayoutDirection XmDirection dynamic CG Page 4 (printed 10/3/02) XXXXmmmmFFFFrrrraaaammmmeeee((((3333XXXX)))) UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV XXXXmmmmFFFFrrrraaaammmmeeee((((3333XXXX)))) XmNnavigationType XmCNavigationType XmNavigationType XmTAB_GROUP CSG XmNpopupHandlerCallback XmCCallback XtCallbackList NULL C XmNshadowThickness XmCShadowThickness Dimension dynamic CSG XmNstringDirection XmCStringDirection XmStringDirection dynamic CG XmNtopShadowColor XmCTopShadowColor Pixel dynamic CSG XmNtopShadowPixmap XmCTopShadowPixmap Pixmap dynamic CSG XmNtraversalOn XmCTraversalOn Boolean True CSG XmNunitType XmCUnitType unsigned char dynamic CSG XmNuserData XmCUserData XtPointer NULL CSG CCCCoooommmmppppoooossssiiiitttteeee RRRReeeessssoooouuuurrrrcccceeee SSSSeeeetttt NNNNaaaammmmeeee CCCCllllaaaassssssss TTTTyyyyppppeeee DDDDeeeeffffaaaauuuulllltttt AAAAcccccccceeeessssssss XmNchildren XmCReadOnly WidgetList NULL G XmNinsertPosition XmCInsertPosition XtOrderProc NULL CSG XmNnumChildren XmCReadOnly Cardinal 0 G CCCCoooorrrreeee RRRReeeessssoooouuuurrrrcccceeee SSSSeeeetttt NNNNaaaammmmeeee CCCCllllaaaassssssss TTTTyyyyppppeeee DDDDeeeeffffaaaauuuulllltttt AAAAcccccccceeeessssssss XmNaccelerators XmCAccelerators XtAccelerators dynamic CSG XmNancestorSensitive XmCSensitive Boolean dynamic G XmNbackground XmCBackground Pixel dynamic CSG XmNbackgroundPixmap XmCPixmap Pixmap XmUNSPECIFIED_PIXMAP CSG XmNborderColor XmCBorderColor Pixel XtDefaultForeground CSG XmNborderPixmap XmCPixmap Pixmap XmUNSPECIFIED_PIXMAP CSG XmNborderWidth XmCBorderWidth Dimension 0 CSG XmNcolormap XmCColormap Colormap dynamic CG XmNdepth XmCDepth int dynamic CG XmNdestroyCallback XmCCallback XtCallbackList NULL C XmNheight XmCHeight Dimension dynamic CSG XmNinitialResourcesPersistent XmCInitialResourcesPersistent Boolean True C XmNmappedWhenManaged XmCMappedWhenManaged Boolean True CSG XmNscreen XmCScreen Screen * dynamic CG XmNsensitive XmCSensitive Boolean True CSG XmNtranslations XmCTranslations XtTranslations dynamic CSG XmNwidth XmCWidth Dimension dynamic CSG XmNx XmCPosition Position 0 CSG XmNy XmCPosition Position 0 CSG TTTTrrrraaaannnnssssllllaaaattttiiiioooonnnnssss XmFrame inherits translations from XmManager. RRRREEEELLLLAAAATTTTEEEEDDDD CCCCoooommmmppppoooossssiiiitttteeee(3), CCCCoooonnnnssssttttrrrraaaaiiiinnnntttt(3), CCCCoooorrrreeee(3), XXXXmmmmCCCCrrrreeeeaaaatttteeeeFFFFrrrraaaammmmeeee(3), and XXXXmmmmMMMMaaaannnnaaaaggggeeeerrrr(3). Page 5 (printed 10/3/02) 
